home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / miscellaneous / help / dos / dosman / man / resident < prev    next >
Encoding:
Text File  |  1996-09-07  |  4.2 KB  |  114 lines
  1.  
  2.             RESIDENT (1.3 in C:) (2.x/3.x Internal)
  3.  
  4.    NAME
  5.             Resident - Loads a program into memory and keeps it 
  6.         resident there where it will be executed without having 
  7.         to be loaded from disk each time.
  8.  
  9.    SYNOPSIS
  10.      1.3:
  11.         RESIDENT name filename [REMOVE] [ADD] [REPLACE] [PURE] 
  12.                  [SYSTEM]
  13.  
  14.      2.x/3.x:
  15.         RESIDENT name filename [REMOVE] [ADD] [REPLACE] [PURE 
  16.                  or FORCE] [SYSTEM]
  17.  
  18.  
  19.    DESCRIPTION
  20.             Resident saves time by loading the command into 
  21.         memory thereby allowing several Shell windows to execute 
  22.         the same program code simultaneously, without having to 
  23.         load another copy of the program for each shell.
  24.  
  25.             A command may only be made resident from 1.3 and 
  26.         above. Also, only program files that have their PURE bit 
  27.         set. Also resident commands must be able to be run many 
  28.         times in a row without being reloaded or reinitialized. 
  29.         It should also be able to be executed from different 
  30.         Shells simultaneously without conflict. How do you know 
  31.         if the file is able to be made resident? Check the Pure 
  32.         bit. If the programmer who made the command followed 
  33.         Commodore standards, it would be set to on. And, 9 times 
  34.         out of 10 the docs will mention the fact.
  35.  
  36.    KEYWORDS
  37.         name
  38.             This is an optional resident name for the program. 
  39.         For instance, you can chose to call the resident version 
  40.         of Delete by the letter D. If you don't specify a name, 
  41.         the filename is used as the resident name.
  42.  
  43.         filename
  44.             The full path name to the file to be made resident.
  45.             
  46.         REMOVE
  47.             This will remove the resident from the resident list. 
  48.         This only succeeds if that command is not currently in 
  49.         use. Under 2.x/3.x you can use this keyword to disable 
  50.         any Internal commands (which may be re-enabled with the 
  51.         REPLACE option).
  52.  
  53.         ADD
  54.         REPLACE
  55.             These keywords are completely optional since they 
  56.         make very little differnece to the execution of the 
  57.         program. If you don't add a filename with these 
  58.         keywordsthen the command will list all the programs on 
  59.         the resident list, just like if you used the command 
  60.         RESIDENT. If you issue a filename with them then RESIDENT 
  61.         will try to add that file to the resident list. If that 
  62.         file already exists it will get replaced by the new 
  63.         command. Under 2.x/3.x REPLACE will fail if the resident 
  64.         name is not on the resident list and you are able to 
  65.         re-enable an internal command that has been disabled with 
  66.         the REMOVE option.
  67.  
  68.         PURE or FORCE
  69.             These cause RESIDENT to force a prgram to be made 
  70.         resident whether or not if the PURE bit is set.  If this 
  71.         keyword is used, you will get a message saying that the 
  72.         pure bit is not set. Data files cannot be made RESIDENT, 
  73.         only executable programs can be. The FORCE keyword can be 
  74.         used under 2.x/3.x and does the exact same thing as pure. 
  75.  
  76.             The use of this keyword can be extremely hazerdous to 
  77.         your system. Don't be surprised if you FORCE a command to 
  78.         be made resident that was not meant to be made resident 
  79.         cause your machine to crash in a very big way. 
  80.  
  81.         SYSTEM
  82.             This keyword will not allow the user to delete that 
  83.         file from the resident list. The most common use of this 
  84.         keyword is the way it enables the Shell windows to 
  85.         replace the CLI under 1.3. The command that  makes the 
  86.         Shell-Seg resident is:
  87.  
  88.             RESIDENT CLI L:Shell-Seg SYSTEM
  89.  
  90.             Under 1.3 this is used in the startup script. But, 
  91.         2.x/3.x does not need it because the Shell is built into 
  92.         the system ROMS.
  93.  
  94.  
  95.         EXAMPLES:
  96.  
  97.             1. Make the Delete command resident, using the name D:
  98.  
  99.             RESIDENT D C:Delete
  100.         
  101.  
  102.             2. To remove the DIR command from the resident list:
  103.  
  104.             RESIDENT dir REMOVE
  105.  
  106.  
  107.             3. To display all the command residing on the resident
  108.                list:
  109.  
  110.             RESIDENT SYSTEM
  111.  
  112.  
  113.             
  114.